API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

accounts

Retrieves a accounts resource.

Retrieves a accounts resource.

Authorizations:
JWT
path Parameters
id
required
string

accounts identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "type": {
    },
  • "ref": "string",
  • "igrf": "string",
  • "metadata": "string",
  • "isRepertoire": true,
  • "acceptsTransactions": true,
  • "parent": { },
  • "children": [
    ],
  • "notes": "string",
  • "shortcode": "AC",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "root": 0,
  • "lvl": 0,
  • "lft": 0,
  • "rgt": 0,
  • "toString": "string",
  • "accountFullName": "string",
  • "accountToolTip": "string",
  • "accountName": "string",
  • "entriesListing": "string",
  • "translationsListing": "string",
  • "customPropertiesListing": "string",
  • "translationTitlePropertyName": "string",
  • "translationDescriptionPropertyName": "string",
  • "childrenListing": "string",
  • "leaf": true,
  • "leafApi": true,
  • "levelApi": 0,
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the accounts resource.

Replaces the accounts resource.

Authorizations:
JWT
path Parameters
id
required
string

accounts identifier

Request Body schema:
required

The updated accounts resource

object (account_types.jsonld-post)

AccountType.

ref
string or null
igrf
string or null
metadata
string or null
isRepertoire
required
boolean
acceptsTransactions
required
boolean
Default: true
budget
required
string
accounts.jsonld-post (object) or null
children
Array of objects (accounts.jsonld-post)

// MUST BE MAPPED IN ENTITY

deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>
apiTranslations
Array of strings
title
any

Responses

Request samples

Content type
{
  • "type": {
    },
  • "ref": "string",
  • "igrf": "string",
  • "metadata": "string",
  • "isRepertoire": true,
  • "acceptsTransactions": true,
  • "budget": "string",
  • "parent": { },
  • "children": [
    ],
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "apiTranslations": [
    ],
  • "title": null
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "type": {
    },
  • "ref": "string",
  • "igrf": "string",
  • "metadata": "string",
  • "isRepertoire": true,
  • "acceptsTransactions": true,
  • "parent": { },
  • "children": [
    ],
  • "notes": "string",
  • "shortcode": "AC",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "root": 0,
  • "lvl": 0,
  • "lft": 0,
  • "rgt": 0,
  • "toString": "string",
  • "accountFullName": "string",
  • "accountToolTip": "string",
  • "accountName": "string",
  • "entriesListing": "string",
  • "translationsListing": "string",
  • "customPropertiesListing": "string",
  • "translationTitlePropertyName": "string",
  • "translationDescriptionPropertyName": "string",
  • "childrenListing": "string",
  • "leaf": true,
  • "leafApi": true,
  • "levelApi": 0,
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the accounts resource.

Removes the accounts resource.

Authorizations:
JWT
path Parameters
id
required
string

accounts identifier

Responses